@stdlib/utils-keys

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Object Keys

Return an array of an object's own enumerable property names.

Installation

npm install @stdlib/utils-keys

Usage

var objectKeys = require( '@stdlib/utils-keys' );

objectKeys( obj )

Returns an array of an object's own enumerable property names.

var obj = {
    'a': 1,
    'b': 2
};

var keys = objectKeys( obj );
// e.g., returns [ 'a', 'b' ]

Notes

• Name order is not guaranteed, as object key enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's keys, thus allowing for deterministic extraction.
• In contrast to the built-in Object.keys(), if provided null or undefined, the function returns an empty array, rather than throwing an error.

Examples

var objectKeys = require( '@stdlib/utils-keys' );

function Foo() {
    this.beep = 'boop';
    this.a = {
        'b': 'c'
    };
    return this;
}

Foo.prototype.foo = [ 'bar' ];

var obj = new Foo();
var keys = objectKeys( obj );

console.log( keys );
// e.g., => [ 'beep', 'a' ]

---

See Also

• @stdlib/utils-entries: return an array of an object's own enumerable property key-value pairs.
• @stdlib/utils-keys-in: return an array of an object's own and inherited enumerable property names.
• @stdlib/utils-nonindex-keys: return an array of an object's own enumerable property names which are not integer indices.
• @stdlib/utils-values: return an array of an object's own enumerable property values.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.